/*
 * Copyright (c) 2012 Mikaël GUILLEMOT
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.g2de.generators;

/**
 * interface utilise par les classes de generation de code. lors de la
 * generation, le generateur est averti des evenements pas cette interface
 */
public interface Generator {

	/**
	 * previen le generateur qu'un marqueur vien d'etre trouvé pour le
	 * remplacement d'une ligne. Cela permet au generateur de reagir
	 * immediatement.
	 * 
	 * @param token
	 *            : la clef qui vien d'etre trouvée
	 */
	public String replaceLine(int token);

	/**
	 * previen le generateur qu'un marqueur vien d'etre trouvé pour le
	 * remplacement d'une expression dans une ligne. Cela permet au generateur
	 * de reagir immediatement.
	 * 
	 * @param token
	 *            : la clef qui vien d'etre trouvée
	 */
	public String replaceTokens(String BaseLine, int token);
}
